<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2014 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: AppendRequest.html 939 2015-05-29 01:16:17Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.jsimpledb.kv.raft.msg;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import com.google.common.base.Preconditions;<a name="line.10"></a>
<span class="sourceLineNo">011</span><a name="line.11"></a>
<span class="sourceLineNo">012</span>import java.nio.ByteBuffer;<a name="line.12"></a>
<span class="sourceLineNo">013</span><a name="line.13"></a>
<span class="sourceLineNo">014</span>import org.jsimpledb.kv.raft.Timestamp;<a name="line.14"></a>
<span class="sourceLineNo">015</span>import org.jsimpledb.util.LongEncoder;<a name="line.15"></a>
<span class="sourceLineNo">016</span><a name="line.16"></a>
<span class="sourceLineNo">017</span>/**<a name="line.17"></a>
<span class="sourceLineNo">018</span> * Sent from leaders to followers to probe the follower's log state and/or append an entry to their log.<a name="line.18"></a>
<span class="sourceLineNo">019</span> *<a name="line.19"></a>
<span class="sourceLineNo">020</span> * &lt;p&gt;<a name="line.20"></a>
<span class="sourceLineNo">021</span> * Instances also provide the {@linkplain #getLeaderLeaseTimeout leader's lease timeout} value, which is<a name="line.21"></a>
<span class="sourceLineNo">022</span> * used to commit read-only transactions, as well as a {@linkplain #getLeaderTimestamp leader timestamp}<a name="line.22"></a>
<span class="sourceLineNo">023</span> * which should be reflected back in the corresponding {@link AppendResponse}.<a name="line.23"></a>
<span class="sourceLineNo">024</span> */<a name="line.24"></a>
<span class="sourceLineNo">025</span>public class AppendRequest extends Message {<a name="line.25"></a>
<span class="sourceLineNo">026</span><a name="line.26"></a>
<span class="sourceLineNo">027</span>    private final Timestamp leaderTimestamp;        // leader's timestamp for this request<a name="line.27"></a>
<span class="sourceLineNo">028</span>    private final Timestamp leaderLeaseTimeout;     // earliest leader timestamp at which time leader could be deposed<a name="line.28"></a>
<span class="sourceLineNo">029</span>    private final long leaderCommit;                // index of highest log entry known to be committed<a name="line.29"></a>
<span class="sourceLineNo">030</span>    private final long prevLogTerm;                 // term of previous log entry<a name="line.30"></a>
<span class="sourceLineNo">031</span>    private final long prevLogIndex;                // index of previous log entry<a name="line.31"></a>
<span class="sourceLineNo">032</span>    private final long logEntryTerm;                // term corresponding to log entry, or zero if this is a "probe"<a name="line.32"></a>
<span class="sourceLineNo">033</span><a name="line.33"></a>
<span class="sourceLineNo">034</span>    private ByteBuffer mutationData;                // serialized mutations, if not a probe and not from follower transaction<a name="line.34"></a>
<span class="sourceLineNo">035</span>    private boolean mutationDataInvalid;            // mutationData has already been grabbed<a name="line.35"></a>
<span class="sourceLineNo">036</span><a name="line.36"></a>
<span class="sourceLineNo">037</span>// Constructors<a name="line.37"></a>
<span class="sourceLineNo">038</span><a name="line.38"></a>
<span class="sourceLineNo">039</span>    /**<a name="line.39"></a>
<span class="sourceLineNo">040</span>     * Construtor for a "probe" that does not contain a log entry.<a name="line.40"></a>
<span class="sourceLineNo">041</span>     *<a name="line.41"></a>
<span class="sourceLineNo">042</span>     * @param clusterId cluster ID<a name="line.42"></a>
<span class="sourceLineNo">043</span>     * @param senderId identity of sender<a name="line.43"></a>
<span class="sourceLineNo">044</span>     * @param recipientId identity of recipient<a name="line.44"></a>
<span class="sourceLineNo">045</span>     * @param term sender's current term<a name="line.45"></a>
<span class="sourceLineNo">046</span>     * @param leaderTimestamp leader's timestamp for this request<a name="line.46"></a>
<span class="sourceLineNo">047</span>     * @param leaderLeaseTimeout earliest leader timestamp at which leader could be deposed<a name="line.47"></a>
<span class="sourceLineNo">048</span>     * @param leaderCommit current commit index for sender<a name="line.48"></a>
<span class="sourceLineNo">049</span>     * @param prevLogTerm term of the log entry just prior to this one<a name="line.49"></a>
<span class="sourceLineNo">050</span>     * @param prevLogIndex index of the log entry just prior to this one<a name="line.50"></a>
<span class="sourceLineNo">051</span>     */<a name="line.51"></a>
<span class="sourceLineNo">052</span>    public AppendRequest(int clusterId, String senderId, String recipientId, long term,<a name="line.52"></a>
<span class="sourceLineNo">053</span>      Timestamp leaderTimestamp, Timestamp leaderLeaseTimeout, long leaderCommit, long prevLogTerm, long prevLogIndex) {<a name="line.53"></a>
<span class="sourceLineNo">054</span>        this(clusterId, senderId, recipientId, term, leaderTimestamp, leaderLeaseTimeout, leaderCommit,<a name="line.54"></a>
<span class="sourceLineNo">055</span>          prevLogTerm, prevLogIndex, 0, null);<a name="line.55"></a>
<span class="sourceLineNo">056</span>    }<a name="line.56"></a>
<span class="sourceLineNo">057</span><a name="line.57"></a>
<span class="sourceLineNo">058</span>    /**<a name="line.58"></a>
<span class="sourceLineNo">059</span>     * Constructor for a request that contains an actual log entry.<a name="line.59"></a>
<span class="sourceLineNo">060</span>     *<a name="line.60"></a>
<span class="sourceLineNo">061</span>     * @param clusterId cluster ID<a name="line.61"></a>
<span class="sourceLineNo">062</span>     * @param senderId identity of sender<a name="line.62"></a>
<span class="sourceLineNo">063</span>     * @param recipientId identity of recipient<a name="line.63"></a>
<span class="sourceLineNo">064</span>     * @param term sender's current term<a name="line.64"></a>
<span class="sourceLineNo">065</span>     * @param leaderTimestamp leader's timestamp for this request<a name="line.65"></a>
<span class="sourceLineNo">066</span>     * @param leaderLeaseTimeout earliest leader timestamp at which leader could be deposed<a name="line.66"></a>
<span class="sourceLineNo">067</span>     * @param leaderCommit current commit index for sender<a name="line.67"></a>
<span class="sourceLineNo">068</span>     * @param prevLogTerm term of the log entry just prior to this one<a name="line.68"></a>
<span class="sourceLineNo">069</span>     * @param prevLogIndex index of the log entry just prior to this one<a name="line.69"></a>
<span class="sourceLineNo">070</span>     * @param logEntryTerm term of this log entry<a name="line.70"></a>
<span class="sourceLineNo">071</span>     * @param mutationData log entry serialized mutations, or null if follower should have the data already<a name="line.71"></a>
<span class="sourceLineNo">072</span>     */<a name="line.72"></a>
<span class="sourceLineNo">073</span>    public AppendRequest(int clusterId, String senderId, String recipientId, long term, Timestamp leaderTimestamp,<a name="line.73"></a>
<span class="sourceLineNo">074</span>      Timestamp leaderLeaseTimeout, long leaderCommit, long prevLogTerm, long prevLogIndex, long logEntryTerm,<a name="line.74"></a>
<span class="sourceLineNo">075</span>      ByteBuffer mutationData) {<a name="line.75"></a>
<span class="sourceLineNo">076</span>        super(Message.APPEND_REQUEST_TYPE, clusterId, senderId, recipientId, term);<a name="line.76"></a>
<span class="sourceLineNo">077</span>        this.leaderTimestamp = leaderTimestamp;<a name="line.77"></a>
<span class="sourceLineNo">078</span>        this.leaderLeaseTimeout = leaderLeaseTimeout;<a name="line.78"></a>
<span class="sourceLineNo">079</span>        this.leaderCommit = leaderCommit;<a name="line.79"></a>
<span class="sourceLineNo">080</span>        this.prevLogTerm = prevLogTerm;<a name="line.80"></a>
<span class="sourceLineNo">081</span>        this.prevLogIndex = prevLogIndex;<a name="line.81"></a>
<span class="sourceLineNo">082</span>        this.logEntryTerm = logEntryTerm;<a name="line.82"></a>
<span class="sourceLineNo">083</span>        this.mutationData = mutationData;<a name="line.83"></a>
<span class="sourceLineNo">084</span>        this.checkArguments();<a name="line.84"></a>
<span class="sourceLineNo">085</span>    }<a name="line.85"></a>
<span class="sourceLineNo">086</span><a name="line.86"></a>
<span class="sourceLineNo">087</span>    AppendRequest(ByteBuffer buf) {<a name="line.87"></a>
<span class="sourceLineNo">088</span>        super(Message.APPEND_REQUEST_TYPE, buf);<a name="line.88"></a>
<span class="sourceLineNo">089</span>        this.leaderTimestamp = Message.getTimestamp(buf);<a name="line.89"></a>
<span class="sourceLineNo">090</span>        this.leaderLeaseTimeout = this.leaderTimestamp.offset((int)LongEncoder.read(buf));<a name="line.90"></a>
<span class="sourceLineNo">091</span>        this.leaderCommit = LongEncoder.read(buf);<a name="line.91"></a>
<span class="sourceLineNo">092</span>        this.prevLogTerm = LongEncoder.read(buf);<a name="line.92"></a>
<span class="sourceLineNo">093</span>        this.prevLogIndex = LongEncoder.read(buf);<a name="line.93"></a>
<span class="sourceLineNo">094</span>        this.logEntryTerm = LongEncoder.read(buf);<a name="line.94"></a>
<span class="sourceLineNo">095</span>        this.mutationData = this.logEntryTerm != 0 &amp;&amp; Message.getBoolean(buf) ? Message.getByteBuffer(buf) : null;<a name="line.95"></a>
<span class="sourceLineNo">096</span>        this.checkArguments();<a name="line.96"></a>
<span class="sourceLineNo">097</span>    }<a name="line.97"></a>
<span class="sourceLineNo">098</span><a name="line.98"></a>
<span class="sourceLineNo">099</span>    @Override<a name="line.99"></a>
<span class="sourceLineNo">100</span>    void checkArguments() {<a name="line.100"></a>
<span class="sourceLineNo">101</span>        super.checkArguments();<a name="line.101"></a>
<span class="sourceLineNo">102</span>        Preconditions.checkArgument(this.leaderTimestamp != null);<a name="line.102"></a>
<span class="sourceLineNo">103</span>        Preconditions.checkArgument(this.leaderLeaseTimeout != null);<a name="line.103"></a>
<span class="sourceLineNo">104</span>        Preconditions.checkArgument(this.leaderCommit &gt;= 0);<a name="line.104"></a>
<span class="sourceLineNo">105</span>        Preconditions.checkArgument(this.prevLogTerm &gt;= 0);<a name="line.105"></a>
<span class="sourceLineNo">106</span>        Preconditions.checkArgument(this.prevLogIndex &gt;= 0);<a name="line.106"></a>
<span class="sourceLineNo">107</span>        Preconditions.checkArgument(this.logEntryTerm &gt;= 0);<a name="line.107"></a>
<span class="sourceLineNo">108</span>        Preconditions.checkArgument(this.mutationData == null || this.logEntryTerm &gt; 0);<a name="line.108"></a>
<span class="sourceLineNo">109</span>    }<a name="line.109"></a>
<span class="sourceLineNo">110</span><a name="line.110"></a>
<span class="sourceLineNo">111</span>// Properties<a name="line.111"></a>
<span class="sourceLineNo">112</span><a name="line.112"></a>
<span class="sourceLineNo">113</span>    public Timestamp getLeaderTimestamp() {<a name="line.113"></a>
<span class="sourceLineNo">114</span>        return this.leaderTimestamp;<a name="line.114"></a>
<span class="sourceLineNo">115</span>    }<a name="line.115"></a>
<span class="sourceLineNo">116</span><a name="line.116"></a>
<span class="sourceLineNo">117</span>    public Timestamp getLeaderLeaseTimeout() {<a name="line.117"></a>
<span class="sourceLineNo">118</span>        return this.leaderLeaseTimeout;<a name="line.118"></a>
<span class="sourceLineNo">119</span>    }<a name="line.119"></a>
<span class="sourceLineNo">120</span><a name="line.120"></a>
<span class="sourceLineNo">121</span>    public long getLeaderCommit() {<a name="line.121"></a>
<span class="sourceLineNo">122</span>        return this.leaderCommit;<a name="line.122"></a>
<span class="sourceLineNo">123</span>    }<a name="line.123"></a>
<span class="sourceLineNo">124</span><a name="line.124"></a>
<span class="sourceLineNo">125</span>    public long getPrevLogTerm() {<a name="line.125"></a>
<span class="sourceLineNo">126</span>        return this.prevLogTerm;<a name="line.126"></a>
<span class="sourceLineNo">127</span>    }<a name="line.127"></a>
<span class="sourceLineNo">128</span><a name="line.128"></a>
<span class="sourceLineNo">129</span>    public long getPrevLogIndex() {<a name="line.129"></a>
<span class="sourceLineNo">130</span>        return this.prevLogIndex;<a name="line.130"></a>
<span class="sourceLineNo">131</span>    }<a name="line.131"></a>
<span class="sourceLineNo">132</span><a name="line.132"></a>
<span class="sourceLineNo">133</span>    public boolean isProbe() {<a name="line.133"></a>
<span class="sourceLineNo">134</span>        return this.logEntryTerm == 0;<a name="line.134"></a>
<span class="sourceLineNo">135</span>    }<a name="line.135"></a>
<span class="sourceLineNo">136</span><a name="line.136"></a>
<span class="sourceLineNo">137</span>    public long getLogEntryTerm() {<a name="line.137"></a>
<span class="sourceLineNo">138</span>        return this.logEntryTerm;<a name="line.138"></a>
<span class="sourceLineNo">139</span>    }<a name="line.139"></a>
<span class="sourceLineNo">140</span><a name="line.140"></a>
<span class="sourceLineNo">141</span>    /**<a name="line.141"></a>
<span class="sourceLineNo">142</span>     * Get the serialized data for the log entry, if any.<a name="line.142"></a>
<span class="sourceLineNo">143</span>     * Returns null if this is a probe or follower is expected to already have the data from a transaction.<a name="line.143"></a>
<span class="sourceLineNo">144</span>     *<a name="line.144"></a>
<span class="sourceLineNo">145</span>     * &lt;p&gt;<a name="line.145"></a>
<span class="sourceLineNo">146</span>     * This method may only be invoked once.<a name="line.146"></a>
<span class="sourceLineNo">147</span>     *<a name="line.147"></a>
<span class="sourceLineNo">148</span>     * @return log entry serialized mutations, or null if this message does not contain data<a name="line.148"></a>
<span class="sourceLineNo">149</span>     * @throws IllegalStateException if this method has already been invoked<a name="line.149"></a>
<span class="sourceLineNo">150</span>     */<a name="line.150"></a>
<span class="sourceLineNo">151</span>    public ByteBuffer getMutationData() {<a name="line.151"></a>
<span class="sourceLineNo">152</span>        Preconditions.checkState(!this.mutationDataInvalid);<a name="line.152"></a>
<span class="sourceLineNo">153</span>        final ByteBuffer result = this.mutationData;<a name="line.153"></a>
<span class="sourceLineNo">154</span>        this.mutationData = null;<a name="line.154"></a>
<span class="sourceLineNo">155</span>        this.mutationDataInvalid = true;<a name="line.155"></a>
<span class="sourceLineNo">156</span>        return result;<a name="line.156"></a>
<span class="sourceLineNo">157</span>    }<a name="line.157"></a>
<span class="sourceLineNo">158</span><a name="line.158"></a>
<span class="sourceLineNo">159</span>// Message<a name="line.159"></a>
<span class="sourceLineNo">160</span><a name="line.160"></a>
<span class="sourceLineNo">161</span>    @Override<a name="line.161"></a>
<span class="sourceLineNo">162</span>    public boolean isLeaderMessage() {<a name="line.162"></a>
<span class="sourceLineNo">163</span>        return true;<a name="line.163"></a>
<span class="sourceLineNo">164</span>    }<a name="line.164"></a>
<span class="sourceLineNo">165</span><a name="line.165"></a>
<span class="sourceLineNo">166</span>    @Override<a name="line.166"></a>
<span class="sourceLineNo">167</span>    public void visit(MessageSwitch handler) {<a name="line.167"></a>
<span class="sourceLineNo">168</span>        handler.caseAppendRequest(this);<a name="line.168"></a>
<span class="sourceLineNo">169</span>    }<a name="line.169"></a>
<span class="sourceLineNo">170</span><a name="line.170"></a>
<span class="sourceLineNo">171</span>    @Override<a name="line.171"></a>
<span class="sourceLineNo">172</span>    public void writeTo(ByteBuffer dest) {<a name="line.172"></a>
<span class="sourceLineNo">173</span>        Preconditions.checkState(!this.mutationDataInvalid);<a name="line.173"></a>
<span class="sourceLineNo">174</span>        super.writeTo(dest);<a name="line.174"></a>
<span class="sourceLineNo">175</span>        Message.putTimestamp(dest, this.leaderTimestamp);<a name="line.175"></a>
<span class="sourceLineNo">176</span>        LongEncoder.write(dest, this.leaderLeaseTimeout.offsetFrom(this.leaderTimestamp));<a name="line.176"></a>
<span class="sourceLineNo">177</span>        LongEncoder.write(dest, this.leaderCommit);<a name="line.177"></a>
<span class="sourceLineNo">178</span>        LongEncoder.write(dest, this.prevLogTerm);<a name="line.178"></a>
<span class="sourceLineNo">179</span>        LongEncoder.write(dest, this.prevLogIndex);<a name="line.179"></a>
<span class="sourceLineNo">180</span>        LongEncoder.write(dest, this.logEntryTerm);<a name="line.180"></a>
<span class="sourceLineNo">181</span>        if (this.logEntryTerm != 0) {<a name="line.181"></a>
<span class="sourceLineNo">182</span>            Message.putBoolean(dest, this.mutationData != null);<a name="line.182"></a>
<span class="sourceLineNo">183</span>            if (this.mutationData != null)<a name="line.183"></a>
<span class="sourceLineNo">184</span>                Message.putByteBuffer(dest, this.mutationData);<a name="line.184"></a>
<span class="sourceLineNo">185</span>        }<a name="line.185"></a>
<span class="sourceLineNo">186</span>    }<a name="line.186"></a>
<span class="sourceLineNo">187</span><a name="line.187"></a>
<span class="sourceLineNo">188</span>    @Override<a name="line.188"></a>
<span class="sourceLineNo">189</span>    protected int calculateSize() {<a name="line.189"></a>
<span class="sourceLineNo">190</span>        Preconditions.checkState(!this.mutationDataInvalid);<a name="line.190"></a>
<span class="sourceLineNo">191</span>        return super.calculateSize()<a name="line.191"></a>
<span class="sourceLineNo">192</span>          + Message.calculateSize(this.leaderTimestamp)<a name="line.192"></a>
<span class="sourceLineNo">193</span>          + LongEncoder.encodeLength(this.leaderLeaseTimeout.offsetFrom(this.leaderTimestamp))<a name="line.193"></a>
<span class="sourceLineNo">194</span>          + LongEncoder.encodeLength(this.leaderCommit)<a name="line.194"></a>
<span class="sourceLineNo">195</span>          + LongEncoder.encodeLength(this.prevLogTerm)<a name="line.195"></a>
<span class="sourceLineNo">196</span>          + LongEncoder.encodeLength(this.prevLogIndex)<a name="line.196"></a>
<span class="sourceLineNo">197</span>          + LongEncoder.encodeLength(this.logEntryTerm)<a name="line.197"></a>
<span class="sourceLineNo">198</span>          + (this.logEntryTerm != 0 ? 1 + (this.mutationData != null ? Message.calculateSize(this.mutationData) : 0) : 0);<a name="line.198"></a>
<span class="sourceLineNo">199</span>    }<a name="line.199"></a>
<span class="sourceLineNo">200</span><a name="line.200"></a>
<span class="sourceLineNo">201</span>// Object<a name="line.201"></a>
<span class="sourceLineNo">202</span><a name="line.202"></a>
<span class="sourceLineNo">203</span>    @Override<a name="line.203"></a>
<span class="sourceLineNo">204</span>    public String toString() {<a name="line.204"></a>
<span class="sourceLineNo">205</span>        return this.getClass().getSimpleName()<a name="line.205"></a>
<span class="sourceLineNo">206</span>          + "[\"" + this.getSenderId() + "\"-&gt;\"" + this.getRecipientId() + "\""<a name="line.206"></a>
<span class="sourceLineNo">207</span>          + ",clusterId=" + String.format("%08x", this.getClusterId())<a name="line.207"></a>
<span class="sourceLineNo">208</span>          + ",term=" + this.getTerm()<a name="line.208"></a>
<span class="sourceLineNo">209</span>          + ",leaderTimestamp=" + this.leaderTimestamp<a name="line.209"></a>
<span class="sourceLineNo">210</span>          + ",leaderLeaseTimeout=" + String.format("%+dms", this.leaderLeaseTimeout.offsetFrom(this.leaderTimestamp))<a name="line.210"></a>
<span class="sourceLineNo">211</span>          + ",leaderCommit=" + this.leaderCommit<a name="line.211"></a>
<span class="sourceLineNo">212</span>          + ",prevLog=" + this.prevLogTerm + "/" + this.prevLogIndex<a name="line.212"></a>
<span class="sourceLineNo">213</span>          + (this.logEntryTerm != 0 ? ",logEntryTerm=" + this.logEntryTerm : "")<a name="line.213"></a>
<span class="sourceLineNo">214</span>          + (this.mutationData != null ?<a name="line.214"></a>
<span class="sourceLineNo">215</span>            ",mutationData=" + this.describe(this.mutationData) : this.mutationDataInvalid ? ",mutationData=invalid" : "")<a name="line.215"></a>
<span class="sourceLineNo">216</span>          + "]";<a name="line.216"></a>
<span class="sourceLineNo">217</span>    }<a name="line.217"></a>
<span class="sourceLineNo">218</span>}<a name="line.218"></a>
<span class="sourceLineNo">219</span><a name="line.219"></a>




























































</pre>
</div>
</body>
</html>
